Skip to content

docs: correct contributor setup instructions - #3376

Merged
bnasslahsen merged 1 commit into
springdoc:mainfrom
ys0v9:docs/fix-contributing-setup
Oct 23, 2026
Merged

docs: correct contributor setup instructions#3376
bnasslahsen merged 1 commit into
springdoc:mainfrom
ys0v9:docs/fix-contributing-setup

Conversation

@ys0v9

@ys0v9 ys0v9 commented Oct 2, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

The contribution guide currently points IntelliJ IDEA users to a nonexistent build.gradle, shows a nonexistent ./mvn script, and recommends JDK 1.8. This updates the setup instructions to match the current Maven project and CI environment.

  • Import the root pom.xml in IntelliJ IDEA.
  • Mention installing Maven and use mvn install from the repository root.
  • Recommend JDK 21 to match CI, without presenting it as the minimum supported Java version.

Validation: checked the instructions against the tracked repository files and .github/workflows/ci.yml; git diff --check passes. Only CONTRIBUTING.adoc changes.

Fixes #3375

@bnasslahsen
bnasslahsen merged commit 8687abd into springdoc:main Oct 23, 2026
bnasslahsen added a commit that referenced this pull request Oct 23, 2026
@bnasslahsen
Build with the Maven Wrapper in the contributing guide
6714503 
The repository now ships the Maven Wrapper, so the guide uses ./mvnw and
no longer asks to install Maven.

See gh-3376

Signed-off-by: Badr NASS LAHSEN <badr.nasslahsen@gmail.com>
bnasslahsen pushed a commit that referenced this pull request Oct 23, 2026
@ys0v9 @bnasslahsen
Correct the contributor setup instructions
4d73bf4 
The guide pointed to a nonexistent build.gradle and ./mvn script, and
recommended JDK 1.8. Import the root pom.xml, build with the Maven
Wrapper, and use JDK 21 as the CI does.

Backport of gh-3376, fixes gh-3375

Signed-off-by: Badr NASS LAHSEN <badr.nasslahsen@gmail.com>
@bnasslahsen

bnasslahsen commented Oct 23, 2026

Copy link
Copy Markdown
Collaborator

Thanks @ys0v9! Merged, with a follow-up using the Maven Wrapper now shipped in the repository (./mvnw install, no Maven installation needed), and backported to spring-boot-3 (4d73bf4).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Outdated project import and build instructions in CONTRIBUTING.adoc

2 participants

@ys0v9 @bnasslahsen